<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Function Overview</title>
<title>CMSIS-FreeRTOS: Function Overview</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 46px;">
  <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">CMSIS-FreeRTOS
   &#160;<span id="projectnumber">Version 9.0.0</span>
   </div>
   <div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
    <ul class="tablist">
      <script type="text/javascript">
		<!--
		writeComponentTabs.call(this);
		//-->
      </script>
	  </ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
      <li><a href="modules.html"><span>Reference</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('functionOverview.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">Function Overview </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="rtos_api2"></a>
CMSIS-RTOS2 API</h1>
<p>Overview of all CMSIS-RTOS C API v2 functions that are implemented in CMSIS-FreeRTOS.</p>
<h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__KernelCtrl.html">Kernel Information and Control</a> </h2>
<ul>
<li><b>osKernelGetInfo:</b> supported</li>
<li><b>osKernelGetState:</b> supported</li>
<li><b>osKernelGetSysTimerCount:</b> supported</li>
<li><b>osKernelGetSysTimerFreq:</b> supported</li>
<li><b>osKernelInitialize:</b> supported</li>
<li><b>osKernelLock:</b> supported</li>
<li><b>osKernelUnlock:</b> supported</li>
<li><b>osKernelRestoreLock:</b> supported</li>
<li><b>osKernelResume:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osKernelStart:</b> supported</li>
<li><b>osKernelSuspend:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osKernelGetTickCount:</b> limited to 32-bit return value.</li>
<li><b>osKernelGetTickFreq:</b> supported</li>
</ul>
<h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__ThreadMgmt.html">Thread Management</a> </h2>
<ul>
<li><b>osThreadDetach:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osThreadEnumerate:</b> supported</li>
<li><b>osThreadExit:</b> supported</li>
<li><b>osThreadGetCount:</b> supported</li>
<li><b>osThreadGetId:</b> supported</li>
<li><b>osThreadGetName:</b> supported</li>
<li><b>osThreadGetPriority:</b> supported</li>
<li><b>osThreadGetStackSize:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osThreadGetStackSpace:</b> supported</li>
<li><b>osThreadGetState:</b> supported</li>
<li><b>osThreadJoin:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osThreadNew:</b> supported</li>
<li><b>osThreadResume:</b> supported</li>
<li><b>osThreadSetPriority:</b> supported</li>
<li><b>osThreadSuspend:</b> supported</li>
<li><b>osThreadTerminate:</b> supported</li>
<li><b>osThreadYield:</b> supported</li>
</ul>
<h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__ThreadFlagsMgmt.html">Thread Flags</a> </h2>
<ul>
<li><b>osThreadFlagsSet:</b> supported</li>
<li><b>osThreadFlagsClear:</b> supported</li>
<li><b>osThreadFlagsGet:</b> supported</li>
<li><b>osThreadFlagsWait:</b> supported</li>
</ul>
<h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__EventFlags.html">Event Flags</a> </h2>
<p>All event flags are limited to 24 bits.</p>
<ul>
<li><b>osEventFlagsGetName:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osEventFlagsNew:</b> supported</li>
<li><b>osEventFlagsDelete:</b> supported</li>
<li><b>osEventFlagsSet:</b> supported</li>
<li><b>osEventFlagsClear:</b> supported</li>
<li><b>osEventFlagsGet:</b> supported</li>
<li><b>osEventFlagsWait:</b> cannot be called from an ISR.</li>
</ul>
<h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__Wait.html">Generic Wait Functions</a> </h2>
<ul>
<li><b>osDelay:</b> supported</li>
<li><b>osDelayUntil:</b> supported</li>
</ul>
<h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__TimerMgmt.html">Timer Management</a> </h2>
<ul>
<li><b>osTimerDelete:</b> supported</li>
<li><b>osTimerGetName:</b> supported</li>
<li><b>osTimerIsRunning:</b> supported</li>
<li><b>osTimerNew:</b> supported</li>
<li><b>osTimerStart:</b> supported</li>
<li><b>osTimerStop:</b> supported</li>
</ul>
<h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__MutexMgmt.html">Mutex Management</a> </h2>
<p>Priority inherit protocol is used as default mutex behavior (osMutexNew creates priority inherit mutex object by default and ignores osMutexPrioInherit attribute when specified).<br/>
Robust mutex objects are not supported (osMutexNew returns NULL when osMutexRobust attribute is specified).</p>
<ul>
<li><b>osMutexAcquire:</b> supported</li>
<li><b>osMutexDelete:</b> supported</li>
<li><b>osMutexGetName:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osMutexGetOwner:</b> supported</li>
<li><b>osMutexNew:</b> supported</li>
<li><b>osMutexRelease:</b> supported</li>
</ul>
<h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__SemaphoreMgmt.html">Semaphores</a> </h2>
<ul>
<li><b>osSemaphoreAcquire:</b> supported</li>
<li><b>osSemaphoreDelete:</b> supported</li>
<li><b>osSemaphoreGetCount:</b> supported</li>
<li><b>osSemaphoreGetName:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osSemaphoreNew:</b> supported</li>
<li><b>osSemaphoreRelease:</b> supported</li>
</ul>
<h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__PoolMgmt.html">Memory Pool</a> </h2>
<p>Memory Pool functions are not implemented and will always return with error.</p>
<ul>
<li><b>osMemoryPoolAlloc:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osMemoryPoolDelete:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osMemoryPoolFree:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osMemoryPoolGetBlockSize:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osMemoryPoolGetCapacity:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osMemoryPoolGetCount:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osMemoryPoolGetName:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osMemoryPoolGetSpace:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osMemoryPoolNew:</b> <span class="XML-Token">not implemented</span></li>
</ul>
<h2><a href="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__Message.html">Message Queue</a> </h2>
<ul>
<li><b>osMessageQueueDelete:</b> supported</li>
<li><b>osMessageQueueGet:</b> ignores message priority.</li>
<li><b>osMessageQueueGetCapacity:</b> supported</li>
<li><b>osMessageQueueGetCount:</b> supported</li>
<li><b>osMessageQueueGetMsgSize:</b> supported</li>
<li><b>osMessageQueueGetName:</b> <span class="XML-Token">not implemented</span></li>
<li><b>osMessageQueueGetSpace:</b> supported</li>
<li><b>osMessageQueueNew:</b> supported</li>
<li><b>osMessageQueuePut:</b> ignores message priority.</li>
<li><b>osMessageQueueReset:</b> supported </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated on Mon Mar 13 2017 09:48:26 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
	<!--
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
	-->
	</li>
  </ul>
</div>
</body>
</html>
